emida-ux

1.0.x
(0 reviews)

Usage Consumption

/queryUsageConsumption

[POST]

This usecase to retrieve usage associated with msisdn number.

URL
https://[host]:[port]/emida-ux/v1/{businessId}/queryUsageConsumption
URI Params
nametypedescriptionrequired
businessIdstringDefault CR for Costa RicaY
Headers
nametypedescriptionrequired
client_idstringThe client_id identifying the channel. Minimum characters: 5Y
client_secretstringPassword associated with the client_id. Minimum characters: 5Y
X-Correlation-IDstringIdentifier that correlates HTTP request between a client and server.
Any identification model (UUDI, checksum, etc.) can be used, as long as it is a unique value to differentiate a transaction.		Y
cURL request
curl --location 'https://nonprod.lcr.esb.cloud.lla.com/test/emida-ux-lcr/emida-ux/v1/CR/queryUsageConsumption' \
--header 'X-Correlation-ID: {{$guid}}' \
--header 'client_secret: ******' \
--header 'client_id: ******' \
--header 'Content-Type: application/json' \
--data-raw '{
   "searchCriteria":{
      "logicalResource":[
         {
            "id":"12345678",
            "@type":"LogicalResource"
         }
      ]
   },
   "@type": "usageConsumption"
}'
Response
{
  "@type": "QueryUsageConsumption",
  "partyAccount": [
    {
      "id": "384087",
      "@baseType": "PartyAccount",
      "@referredType": "BillingAccount"
    }
  ],
  "relatedParty": [
    {
      "id": "392603",
      "role": "Customer",
      "@referredType": "Individual"
    }
  ],
  "usageConsumption": [
    {
      "logicalResource": [
        {
          "id": "12345678",
          "@type": "LogicalResource"
        }
      ],
      "service": [
        {
          "id": "23345",
          "@type": "Service"
        }
      ],
      "bucketRefOrValue": [
        {
          "id": "DCET",
          "usageType": "DATOS",
          "bucketCounter": [
            {
              "counterType": "used",
              "value": {
                "amount": 0,
                "units": "KB"
              }
            }
          ],
          "remainingValue": {
            "amount": 10.48,
            "units": "GB"
          },
          "validPeriod": {
            "startDateTime": "2022-12-06T13:56:48.000-06:00",
            "endDateTime": "2032-12-06T13:56:48.000-06:00"
          },
          "bucketRelationship": [
            {
              "relationshipType": "Aggregated",
              "bucketRefOrValue": {
                "id": "BDATCET"
              }
            }
          ]
        }
      ],
      "product": [
        {
          "id": "CA",
          "name": "PLAN CONTROL @5 LTE PRO CT"
        }
      ]
    }
  ]
}

Reviews